DescribeDiagnosisMonitorPerformance - 查询智能运维的监控信息

更新时间:

用于获取用户选定时间范围内查询的执行开始时间信息和结束时间信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
adb:DescribeDiagnosisMonitorPerformanceget
*DBCluster
acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

请求参数

名称类型必填描述示例值
DBClusterIdstring

数仓版集群 ID。

说明 您可以调用 DescribeDBClusters 接口查询目标地域中所有数仓版集群的集群 ID。
am-bp108q1py5r78****
StartTimestring

开始时间。格式为 Unix 时间戳,单位为毫秒。

1671684348000
EndTimestring

结束时间。格式为 Unix 时间戳,单位为毫秒。

1671687948000
RegionIdstring

地域 ID。

说明 您可以调用 DescribeRegions 接口查看指定数仓版支持的地域 ID。
cn-beijing
QueryConditionstring

指定 SQL 的查询条件,格式为 JSON 字符串,包含TypeValueMinMax等字段。其中Type 表示查询维度(当前仅支持 3 个取值:maxCoststatuscost),ValueMinMax表示该维度下的查询范围。具体支持的取值范围如下:

  • {"Type":"maxCost","Value":"100"}:表示查看执行耗时最长的前 100 条 SQL 详情,当前Value的取值仅支持设置为 100。
  • {"Type":"status","Value":"finished"}:表示查看已完成的 SQL 详情(包含执行成功和失败的 SQL)。您也可以将Value设置为runningfailed来查询正在执行或执行失败的 SQL 详情。
  • {"Type":"cost","Min":"10","Max":"200"}:表示查看执行耗时为 10 毫秒~200 毫秒的 SQL 详情,您也可以自定义执行耗时的最大值与最小值,单位:毫秒。
{\"Type\":\"maxCost\",\"Value\":\"100\"}
Langstring

设置下载文件的文件标题以及部分错误信息的语言,支持如下语言:

  • zh:简体中文(默认语言)。
  • en:英文。
  • ja:日文。
  • zh-tw:繁体中文。
zh

返回参数

名称类型描述示例值
object
PerformancesThresholdinteger

绘制甘特图的查询条数阈值,默认为 10000 条。

说明 即使实际的查询条数多于 10000 条,也只会使用 10000 条查询绘制甘特图。
10000
PerformancesTruncatedboolean

当前返回的查询是否为全部查询。返回值说明:

  • true:当前返回的查询条数是全部查询。
  • false:后台限制了返回条数,即当前返回的查询不是全部查询。
false
RequestIdstring

请求 ID。

0F1AC5FD-16E9-5399-B81F-5AC434B1D9F8
Performancesarray<object>

绘制甘特图的数据列表。

Itemsobject

甘特图性能数据。

Statusstring

SQL 语句的状态,取值为:

  • running:执行中。
  • finished:已完成。
  • failed:执行失败。
running
ProcessIdstring

任务 ID。

202210311015270330101470300315153****
StartTimelong

目标 SQL 语句的执行开始时间,格式为 Unix 时间戳,单位为毫秒。

1669011260000
Costlong

查询的总耗时。单位:毫秒。

说明 该耗时指标是QueuedTimeTotalPlanningTimeExecutionTime三个耗时指标的累加值。
252
ScanRowslong

扫描行数。

2345
PeakMemorylong

查询的峰值内存,单位:Byte。

123
RcHoststring

执行 SQL 语句的 AnalyticDB MySQL 前端节点 IP。

192.168.XX.XX
ScanSizelong

扫描数据量,单位:Byte。

123
UserNamestring

提交查询使用的用户名。

rpt

示例

正常返回示例

JSON格式

{
  "PerformancesThreshold": 10000,
  "PerformancesTruncated": false,
  "RequestId": "0F1AC5FD-16E9-5399-B81F-5AC434B1D9F8",
  "Performances": [
    {
      "Status": "running",
      "ProcessId": "202210311015270330101470300315153****",
      "StartTime": 1669011260000,
      "Cost": 252,
      "ScanRows": 2345,
      "PeakMemory": 123,
      "RcHost": "192.168.XX.XX",
      "ScanSize": 123,
      "UserName": "rpt"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-08-30API 内部配置变更,不影响调用查看变更详情